FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageau.gov.digitalhealth.cc
Resource TypeStructureDefinition
IdStructureDefinition-source-cda-document-identifier.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/AuDigitalHealth/common-components/StructureDefinition-source-cda-document-identifier.html
URLhttp://digitalhealth.gov.au/fhir/cc/StructureDefinition/source-cda-document-identifier
Version26.0.0
Statusdraft
Date2026-07-14T04:17:55+00:00
NameSource_CDA_Document_Identifier
TitleSource CDA Document Identifier
Realmau
DescriptionThe instance identifier of the source CDA clinical document from which this FHIR resource was derived. Carries the `/ClinicalDocument/id` value to preserve source document provenance in a FHIR context.
PurposeThe purpose of this extension is to record the source CDA document instance identifier on FHIR resources derived from CDA, enabling traceability back to the originating clinical document without conflating provenance with the resource's own business identifiers.
CopyrightThis content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)
TypeExtension
Kindcomplex-type

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
au.gov.digitalhealth.cc#currentcda-instance-identifierCDA Instance Identifier

Examples of Use for Extension

ResourceVersion
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-cda-extensions-exampleR4
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-repeat-progression-example-1R4
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-repeat-progression-example-2R4
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-repeat-progression-example-3R4
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-repeat-progression-example-4R4
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-repeat-progression-example-5R4
au.gov.digitalhealth.cc#current:MedicationDispense/medicationdispense-repeat-progression-example-6R4
au.gov.digitalhealth.cc#current:MedicationRequest/medicationrequest-cda-extensions-exampleR4

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition source-cda-document-identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extension(4.0.1)Source CDA Document Identifier
... extension 0..0Extension
... url 1..1uri"http://digitalhealth.gov.au/fhir/cc/StructureDefinition/source-cda-document-identifier"
... value[x] 0..1CDA_Instance_Identifier(26.0.0)Source CDA document identifier

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "source-cda-document-identifier",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/source-cda-document-identifier",
  "version": "26.0.0",
  "name": "Source_CDA_Document_Identifier",
  "title": "Source CDA Document Identifier",
  "status": "draft",
  "experimental": false,
  "date": "2026-07-14T04:17:55+00:00",
  "publisher": "Australian Digital Health Agency",
  "contact": [
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.digitalhealth.gov.au/"
        },
        {
          "system": "email",
          "value": "help@digitalhealth.gov.au"
        }
      ]
    },
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:help@digitalhealth.gov.au",
          "use": "work"
        }
      ]
    }
  ],
  "description": "The instance identifier of the source CDA clinical document from which this FHIR resource was derived. Carries the `/ClinicalDocument/id` value to preserve source document provenance in a FHIR context.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "AU",
          "display": "Australia"
        }
      ]
    }
  ],
  "purpose": "The purpose of this extension is to record the source CDA document instance identifier on FHIR resources derived from CDA, enabling traceability back to the originating clinical document without conflating provenance with the resource's own business identifiers.",
  "copyright": "This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "MedicationDispense"
    },
    {
      "type": "element",
      "expression": "MedicationRequest"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Source CDA Document Identifier",
        "definition": "The instance identifier of the source CDA clinical document from which this FHIR resource was derived. Carries the `/ClinicalDocument/id` value to preserve source document provenance in a FHIR context.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
          }
        ],
        "isModifier": false
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/source-cda-document-identifier",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Source CDA document identifier",
        "definition": "The instance identifier of the source CDA clinical document. Maps from /ClinicalDocument/id with @root expressed as urn:oid:{root} in identifier.value (system = urn:ietf:rfc:3986), and the PCEHR repository OID and display name in identifier.assigner.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/cda-instance-identifier|26.0.0"
            ]
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Source CDA Document Identifier",
        "definition": "The instance identifier of the source CDA clinical document from which this FHIR resource was derived. Carries the `/ClinicalDocument/id` value to preserve source document provenance in a FHIR context."
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/source-cda-document-identifier"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Source CDA document identifier",
        "definition": "The instance identifier of the source CDA clinical document. Maps from /ClinicalDocument/id with @root expressed as urn:oid:{root} in identifier.value (system = urn:ietf:rfc:3986), and the PCEHR repository OID and display name in identifier.assigner.",
        "type": [
          {
            "code": "Identifier",
            "profile": [
              "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/cda-instance-identifier|26.0.0"
            ]
          }
        ]
      }
    ]
  }
}